Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: update make targets and docs #41

Merged
merged 4 commits into from
Feb 9, 2024
Merged

Conversation

caseyw
Copy link
Contributor

@caseyw caseyw commented Feb 8, 2024

Working on #openo11y docs, and wanted to view the changes before pushing.

The readme lists three steps, but having worked with mkdocs before I just wanted to simply serve. I thought running
make install-deps serve would suffice in surfacing up the docs.

Instead, I saw:

Command not found: mkdocs

The command make install-deps infers it will install the dependencies, but mkdocs aren't included. I found it in the Poetry config, and realized I needed to build the static assets, or use a target the README didn't reference.

I structured the Makefile slightly differently, and now the install deps target works to install both.

@caseyw caseyw requested a review from a team as a code owner February 8, 2024 16:01
@caseyw caseyw changed the title fix: update make target to install dependencies in order fix: update make targets and docs Feb 8, 2024
README.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@adrielp adrielp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left just a couple comments.

@caseyw caseyw requested a review from adrielp February 9, 2024 13:40
@adrielp adrielp merged commit 8c7ce88 into main Feb 9, 2024
3 checks passed
@adrielp adrielp deleted the docs/tweak-how-we-spin-up branch February 9, 2024 16:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants